Skip to content

Add Housing Benefit documentation page (#771)#1705

Merged
vahid-ahmadi merged 2 commits into
mainfrom
vahid-ahmadi/issue-771-housing-benefit-docs
Jun 5, 2026
Merged

Add Housing Benefit documentation page (#771)#1705
vahid-ahmadi merged 2 commits into
mainfrom
vahid-ahmadi/issue-771-housing-benefit-docs

Conversation

@vahid-ahmadi

Copy link
Copy Markdown
Collaborator

Summary

  • Ticks off one of the unchecked items in Documentation pages #771's docs-pages todo list (Housing Benefit).
  • New page at docs/book/programs/gov/dwp/housing-benefit.ipynb covering:
    • the legacy status of HB and its overlap with the UC housing element,
    • eligibility (housing_benefit_eligible gate plus the would_claim_housing_benefit take-up input),
    • the four-stage entitlement pipeline — eligible rent (with LHA cap) -> applicable amount -> means test taper -> benefit cap reduction — with pointers to each underlying variable,
    • a chart of weekly personal allowances by composition (single / lone parent / couple) and age band,
    • statutory references (SSCBA 1992 s.130, SI 2006/213, SI 2006/214) plus the DWP HB caseload statistics page used for calibration.

Test plan

  • Notebook is valid JSON and parameter paths used in the allowances chart all resolve via system.parameters.gov.dwp.housing_benefit.allowances.
  • Docs build job renders the new page.

🤖 Generated with Claude Code

vahid-ahmadi and others added 2 commits May 27, 2026 10:41
Ticks off one of the unchecked items in #771's docs-pages todo list.

Covers:
- the legacy status of HB and its overlap with the UC housing element,
- eligibility (already-claiming gate, social housing / LHA, no UC, capital
  limits, and the would_claim_housing_benefit take-up input),
- the four-stage entitlement computation (eligible rent + applicable
  amount + means test + benefit cap) with pointers to each underlying
  variable,
- a chart of weekly personal allowances by composition/age,
- statutory references (SSCBA 1992 s.130, SI 2006/213, SI 2006/214) and
  DWP caseload statistics.
Ensures the docs-only PR passes the repo-wide ruff format --check that
later code PRs trigger on main.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@vahid-ahmadi vahid-ahmadi merged commit de1a518 into main Jun 5, 2026
1 check passed
@vahid-ahmadi vahid-ahmadi deleted the vahid-ahmadi/issue-771-housing-benefit-docs branch June 5, 2026 12:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant